countup.js

What is countup.js?

countup.js is a lightweight JavaScript library that allows you to create animated counting numbers. It is useful for creating dynamic and engaging number displays in web applications, such as statistics, counters, and other numerical data visualizations.

What are countup.js's main functionalities?

Basic Count Up

This feature allows you to animate a number counting up from zero to a specified value. In this example, the number will count up to 1000 and display in the element with the ID 'targetElement'.

const countUp = new CountUp('targetElement', 1000);
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Custom Start and End Values

This feature allows you to specify custom start and end values for the count up animation. In this example, the number will count up from 500 to 2000.

const countUp = new CountUp('targetElement', 2000, { startVal: 500 });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Formatting Options

This feature allows you to format the number with options such as decimal places, prefixes, and suffixes. In this example, the number will be formatted with two decimal places and display as currency (e.g., $1000.00 USD).

const countUp = new CountUp('targetElement', 1000, { decimalPlaces: 2, prefix: '$', suffix: ' USD' });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Easing Functions

This feature allows you to apply custom easing functions to the count up animation. In this example, a quadratic easing function is used to create a smooth animation effect.

const countUp = new CountUp('targetElement', 1000, { easingFn: function (t, b, c, d) { return c * (t /= d) * t + b; } });
if (!countUp.error) {
  countUp.start();
} else {
  console.error(countUp.error);
}

Other packages similar to countup.js

odometer

Odometer is a smooth, themeable, and easy-to-use JavaScript library for transitioning numbers. It provides a more visually appealing way to animate numbers compared to countup.js, with various themes and styles that mimic the look of an odometer.

jquery.counterup

jquery.counterup is a jQuery plugin that animates a number from zero to a specified value. It is similar to countup.js but requires jQuery as a dependency, making it less lightweight. It is suitable for projects that already use jQuery.

README

CountUp.js

CountUp.js is a dependency-free, lightweight JavaScript "class" that can be used to quickly create animations that display numerical data in a more interesting way.

Despite its name, CountUp can count in either direction, depending on the startVal and endVal params that you pass.

CountUp.js supports all browsers.

Try the demo

Please note

Angular 1 and 2 modules used to be part of this repo. As of v1.9.0, they have moved. See links below.

See Also

• CountUp.js Angular 1.x Module
• CountUp.js Angular ^2 Module
• CountUp.js React
• CountUp.js Vue component wrapper
• CountUp.js WordPress Plugin

Installation

Simply include the countUp.js file in your project or install via npm or bower using the package name countup.js or countUp.js respectively.

Before making a pull request, please read this. MIT License.

A jQuery version is also included in case you like dollar signs.

Usage:

Params:

• target = id of html element, input, svg text element, or var of previously selected element/input where counting occurs
• startVal = the value you want to begin at
• endVal = the value you want to arrive at
• decimals = (optional) number of decimal places in number, default 0
• duration = (optional) duration in seconds, default 2
• options = (optional, see demo) formatting/easing options object

Decimals, duration, and options can be left out to use the default values.

var numAnim = new CountUp("SomeElementYouWantToAnimate", 24.02, 99.99);
if (!numAnim.error) {
    numAnim.start();
} else {
    console.error(numAnim.error);
}

with optional callback:

numAnim.start(someMethodToCallOnComplete);

// or an anonymous function
numAnim.start(function() {
    // do something
})

Other methods:

Toggle pause/resume:

numAnim.pauseResume();

Reset an animation:

numAnim.reset();

Update the end value and animate:

var someValue = 1337;
numAnim.update(someValue);

Animating to large numbers

For large numbers, since CountUp has a long way to go in just a few seconds, the animation seems to abruptly stop. The solution is to subtract 100 from your endVal, then use the callback to invoke the update method which completes the animation with the same duration with a difference of only 100 to animate:

var endVal = 9645.72;
var numAnim = new CountUp("targetElem", 0, endVal - 100, 2, duration/2);
numAnim.start(function() {
	numAnim.update(endVal);
});

Contributing

Before you make a pull request, please be sure to follow these super simple instructions:

1. Do your work on countUp.js and/or other files in the root directory.
2. In Terminal, cd to the countUp.js directory.
3. Run npm install, which installs gulp and its dependencies.
4. Run gulp, which copies and minifies the .js files to the dist folder.